home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib / tk / option.man < prev    next >
Encoding:
Text File  |  1992-08-24  |  7.2 KB  |  269 lines
  1. '\"
  2. '\" Copyright 1990 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. '\" $Header: /user6/ouster/wish/man/RCS/option.man,v 1.3 91/12/06 10:42:40 ouster Exp $ SPRITE (Berkeley)
  11. '/" 
  12. .\" The definitions below are for supplemental macros used in Sprite
  13. .\" manual entries.
  14. .\"
  15. .\" .HS name section [date [version]]
  16. .\"    Replacement for .TH in other man pages.  See below for valid
  17. .\"    section names.
  18. .\"
  19. .\" .AP type name in/out [indent]
  20. .\"    Start paragraph describing an argument to a library procedure.
  21. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  22. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  23. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  24. .\"    needed;  use .AS below instead)
  25. .\"
  26. .\" .AS [type [name]]
  27. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  28. .\"    name are examples of largest possible arguments that will be passed
  29. .\"    to .AP later.  If args are omitted, default tab stops are used.
  30. .\"
  31. .\" .BS
  32. .\"    Start box enclosure.  From here until next .BE, everything will be
  33. .\"    enclosed in one large box.
  34. .\"
  35. .\" .BE
  36. .\"    End of box enclosure.
  37. .\"
  38. .\" .VS
  39. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  40. .\"    of man pages.
  41. .\"
  42. .\" .VE
  43. .\"    End of vertical sidebar.
  44. .\"
  45. .\" .DS
  46. .\"    Begin an indented unfilled display.
  47. .\"
  48. .\" .DE
  49. .\"    End of indented unfilled display.
  50. .\"
  51. '\"    # Heading for Sprite man pages
  52. .de HS
  53. .if '\\$2'cmds'       .TH \\$1 1 \\$3 \\$4
  54. .if '\\$2'lib'        .TH \\$1 3 \\$3 \\$4
  55. .if '\\$2'tcl'        .TH \\$1 3 \\$3 \\$4
  56. .if '\\$2'tk'         .TH \\$1 3 \\$3 \\$4
  57. .if t .wh -1.3i ^B
  58. .nr ^l \\n(.l
  59. .ad b
  60. ..
  61. '\"    # Start an argument description
  62. .de AP
  63. .ie !"\\$4"" .TP \\$4
  64. .el \{\
  65. .   ie !"\\$2"" .TP \\n()Cu
  66. .   el          .TP 15
  67. .\}
  68. .ie !"\\$3"" \{\
  69. .ta \\n()Au \\n()Bu
  70. \&\\$1    \\fI\\$2\\fP    (\\$3)
  71. .\".b
  72. .\}
  73. .el \{\
  74. .br
  75. .ie !"\\$2"" \{\
  76. \&\\$1    \\fI\\$2\\fP
  77. .\}
  78. .el \{\
  79. \&\\fI\\$1\\fP
  80. .\}
  81. .\}
  82. ..
  83. '\"    # define tabbing values for .AP
  84. .de AS
  85. .nr )A 10n
  86. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  87. .nr )B \\n()Au+15n
  88. .\"
  89. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  90. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  91. ..
  92. '\"    # BS - start boxed text
  93. '\"    # ^y = starting y location
  94. '\"    # ^b = 1
  95. .de BS
  96. .br
  97. .mk ^y
  98. .nr ^b 1u
  99. .if n .nf
  100. .if n .ti 0
  101. .if n \l'\\n(.lu\(ul'
  102. .if n .fi
  103. ..
  104. '\"    # BE - end boxed text (draw box now)
  105. .de BE
  106. .nf
  107. .ti 0
  108. .mk ^t
  109. .ie n \l'\\n(^lu\(ul'
  110. .el \{\
  111. .\"    Draw four-sided box normally, but don't draw top of
  112. .\"    box if the box started on an earlier page.
  113. .ie !\\n(^b-1 \{\
  114. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  115. .\}
  116. .el \}\
  117. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  118. .\}
  119. .\}
  120. .fi
  121. .br
  122. .nr ^b 0
  123. ..
  124. '\"    # VS - start vertical sidebar
  125. '\"    # ^Y = starting y location
  126. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  127. .de VS
  128. .mk ^Y
  129. .ie n 'mc \s12\(br\s0
  130. .el .nr ^v 1u
  131. ..
  132. '\"    # VE - end of vertical sidebar
  133. .de VE
  134. .ie n 'mc
  135. .el \{\
  136. .ev 2
  137. .nf
  138. .ti 0
  139. .mk ^t
  140. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  141. .sp -1
  142. .fi
  143. .ev
  144. .\}
  145. .nr ^v 0
  146. ..
  147. '\"    # Special macro to handle page bottom:  finish off current
  148. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  149. '\"    # page bottom macro.
  150. .de ^B
  151. .ev 2
  152. 'ti 0
  153. 'nf
  154. .mk ^t
  155. .if \\n(^b \{\
  156. .\"    Draw three-sided box if this is the box's first page,
  157. .\"    draw two sides but no top otherwise.
  158. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  159. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  160. .\}
  161. .if \\n(^v \{\
  162. .nr ^x \\n(^tu+1v-\\n(^Yu
  163. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  164. .\}
  165. .bp
  166. 'fi
  167. .ev
  168. .if \\n(^b \{\
  169. .mk ^y
  170. .nr ^b 2
  171. .\}
  172. .if \\n(^v \{\
  173. .mk ^Y
  174. .\}
  175. ..
  176. '\"    # DS - begin display
  177. .de DS
  178. .RS
  179. .nf
  180. .sp
  181. ..
  182. '\"    # DE - end display
  183. .de DE
  184. .fi
  185. .RE
  186. .sp .5
  187. ..
  188. .HS option cmds
  189. .BS
  190. '\" Note:  do not modify the .SH NAME line immediately below!
  191. .SH NAME
  192. option \- Add/retrieve window options to/from the option database
  193. .SH SYNOPSIS
  194. \fBoption add \fIpattern value \fR?\fIpriority\fR?
  195. .sp
  196. \fBoption clear\fR
  197. .sp
  198. \fBoption get \fIwindow name class\fR
  199. .sp
  200. \fBoption readfile \fIfileName \fR?\fIpriority\fR?
  201. .BE
  202.  
  203. .SH DESCRIPTION
  204. .PP
  205. The \fBoption\fR command allows you to add entries to the Tk option
  206. database or to retrieve options from the database.  The \fBadd\fR
  207. form of the command adds a new option to the database.
  208. \fIPattern\fR contains
  209. the option being specified, and consists of names and/or classes
  210. separated by asterisks or dots, in the usual X format.  \fIValue\fR
  211. contains a text string to associate with \fIpattern\fR;  this is the
  212. value that will be returned in calls to \fBTk_GetOption\fR or by
  213. invocations of the \fBoption get\fR command.  If \fIpriority\fR
  214. is specified, it indicates the priority level for this option (see
  215. below for legal values);  it defaults to \fBinteractive\fR.
  216. This command always returns an empty string.
  217. .PP
  218. The \fBoption clear\fR command clears the option database.  Default
  219. options (from the
  220. \fBRESOURCE_MANAGER\fR property or the \fB.Xdefaults\fR
  221. file) will be reloaded automatically the next time an
  222. option is added to the database or removed from it.  This command
  223. always returns an empty string.
  224. .PP
  225. The \fBoption get\fR command returns the value of the option
  226. specified for \fIwindow\fR
  227. under \fIname\fR and \fIclass\fR.  If several entries in the option
  228. database match \fIwindow\fR, \fIname\fR, and \fIclass\fR, then
  229. the command returns whichever was created with highest
  230. \fIpriority\fR level.  If there are several matching
  231. entries at the same priority level, then it returns whichever entry
  232. was most recently entered into the option database.  If there are
  233. no matching entries, then the empty string is returned.
  234. .PP
  235. The \fBreadfile\fR form of the command reads \fIfileName\fR,
  236. which should have the standard format for an
  237. X resource database such as \fB.Xdefaults\fR, and adds all the
  238. options specified in that file to the option database.  If \fIpriority\fR
  239. is specified, it indicates the priority level at which to enter the
  240. options;  \fIpriority\fR defaults to \fBinteractive\fR.
  241. .PP
  242. The \fIpriority\fR arguments to the \fBoption\fR command are
  243. normally specified symbolically using one of the following values:
  244. .TP
  245. \fBwidgetDefault\fR
  246. Level 20.  Used for default values hard-coded into widgets.
  247. .TP
  248. \fBstartupFile\fR
  249. Level 40.  Used for options specified in application-specific
  250. startup files.
  251. .TP
  252. \fBuserDefault\fR
  253. Level 60.  Used for options specified in user-specific defaults
  254. files, such as \fB.Xdefaults\fR, resource databases loaded into
  255. the X server, or user-specific startup files.
  256. .TP
  257. \fBinteractive\fR
  258. Level 80.  Used for options specified interactively after the application
  259. starts running.  If \fIpriority\fR isn't specified, it defaults to
  260. this level.
  261. .LP
  262. Any of the above keywords may be abbreviated.  In addition, priorities
  263. may be specified numerically using integers between 0 and 100,
  264. inclusive.  The numeric form is probably a bad idea except for new priority
  265. levels other than the ones given above.
  266.  
  267. .SH KEYWORDS
  268. database, option, priority, retrieve
  269.